home *** CD-ROM | disk | FTP | other *** search
/ Pluspack 1 / Caligari Corporation Pluspack1 1998.iso / TSX_SDK / tsxINC / tsxAView.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-01-28  |  9.0 KB  |  242 lines
  1. //******************************************************************************
  2. //    File: tsxAView.h
  3. //  Module: trueSpace eXtensions API
  4. //   Descr: Interface to the Active View
  5. //******************************************************************************
  6.  
  7. #ifndef TSXAVIEW_H
  8. #define TSXAVIEW_H
  9.  
  10.  
  11. #include "tsxTypes.h"
  12.  
  13.  
  14. //------------------------------------------------------------------------------
  15. //------------------------------------------------------------------------------
  16.  
  17. // This is the interface to the active viewport and its "eye" attributes.
  18. // The Active Viewport is the currently active view into the scene.
  19. // Eye attributes:
  20. // - Position
  21. // - Bank angle w.r.t. the world X axis
  22. // - "Look at" direction
  23. // - Zoom
  24. // The eye's frame is similar to that of a Camera, with the Z axis pointing
  25. // out into the scene, and the Y axis pointing up.
  26. // See also "tsxCamra.h" and "tsxMouse.h".
  27.  
  28. //------------------------------------------------------------------------------
  29. //    Related Types
  30. //------------------------------------------------------------------------------
  31.  
  32. // Rendering modes
  33. enum tsxRENDERMODE {
  34.     e_tsxRM_UNDEF = 0,
  35.     e_tsxRM_WIRE,   //Wire-frame
  36.     e_tsxRM_3DR,    //3DR
  37.     e_tsxRM_D3D     //Direct3D
  38. };
  39.  
  40. // Viewing modes
  41. enum tsxVIEWMODE {
  42.     e_tsxVM_PERSPECTIVE,
  43.     e_tsxVM_TOP,
  44.     e_tsxVM_FRONT,
  45.     e_tsxVM_LEFT,
  46.     e_tsxVM_CAMERA //Look through an object or camera
  47. };
  48.  
  49. #define tsxLIL_EOLINES        -1
  50.     /* end of line list */
  51. #define tsxLIL_NEWSTART        -2
  52.     /* start of new bunch of linked lines */
  53.  
  54. enum tsxPEN {
  55.     e_tsxPEN_BACKGROUND = 0,    /* background color */
  56.     e_tsxPEN_GRID,                /* grid lines color */
  57.     e_tsxPEN_ACTIVE,            /* active object color */
  58.     e_tsxPEN_SCENE,                /* scene objects */
  59.     e_tsxPEN_ACTIVESUB,            /* active sub object color */
  60.     e_tsxPEN_INACTIVESUB,        /* inactive sub object color */
  61.     e_tsxPEN_CONTROL,            /* inactive control objects */
  62.     e_tsxPEN_ACTIVECONTROL,        /* active control objects */
  63.     e_tsxPEN_RED,
  64.     e_tsxPEN_GREEN,
  65.     e_tsxPEN_BLUE
  66. };
  67.  
  68. TSXAPIFN void tsxAViewSetPen( tsxPEN pen );
  69.  
  70. TSXAPIFN tsxBOOL tsxAViewDrawLinelist(
  71.     CtsxTxmx3f* trans,
  72.     CtsxVector3f* vects,
  73.     long numVects,
  74.     long* linelist,
  75.     CtsxRect* rect
  76.     );
  77.  
  78. //------------------------------------------------------------------------------
  79. //    Refreshing the Active View
  80. //------------------------------------------------------------------------------
  81.  
  82. // Use this function to refresh the active view of the scene after changing
  83. // the view's attributes.
  84. TSXAPIFN void tsxAViewRefresh();
  85.  
  86. //------------------------------------------------------------------------------
  87. //    Refreshing All Views Simultaneously
  88. //------------------------------------------------------------------------------
  89.  
  90. // Use this function to refresh all views of the scene simultaneously
  91. TSXAPIFN void tsxAllViewsRefresh();
  92.  
  93. //------------------------------------------------------------------------------
  94. //    Render and View Mode
  95. //------------------------------------------------------------------------------
  96.  
  97. // Get the rendering mode of the active view.
  98. TSXAPIFN tsxRENDERMODE tsxAViewGetRenderMode();
  99.  
  100. // Get the view mode for the active view.
  101. TSXAPIFN tsxVIEWMODE tsxAViewGetViewMode();
  102.  
  103. // Change the view mode for teh active view.
  104. // If newmode is e_tsxVM_CAMERA, it is set to look through the currently
  105. // selected object, if any. Useful with Cameras and Lights.
  106. // Returns: e_tsxTRUE if there is a change in mode.
  107. TSXAPIFN tsxBOOL tsxAViewSetViewMode( tsxVIEWMODE newmode );
  108.  
  109. // Make the active view look through an object (pGNode), until further notice.
  110. // In this mode, any changes to the eye's position, orientation and direction
  111. // will also be transmitted to the object.
  112. TSXAPIFN tsxERR tsxAViewSetCameraMode( tsxGNODE* pGNode );
  113.  
  114. // Turn off the camera mode, removing the constraint on the active view
  115. // to look through an object. The current view of the scene is not changed.
  116. TSXAPIFN void tsxAViewUnsetCameraMode();
  117.  
  118. // Get pointer to the object that the active view is currently constrained
  119. // to look through, if any.
  120. TSXAPIFN tsxSOBJ* tsxAViewGetCameraObj();
  121.  
  122.  
  123. //------------------------------------------------------------------------------
  124. //    Eye attributes
  125. //------------------------------------------------------------------------------
  126.  
  127. // Get the eye position (copied into `posn') in world coordinates
  128. TSXAPIFN void tsxAViewGetPosition( CtsxVector3f* posn );
  129.  
  130. // Get the direction in which the view is pointed, as a normalized
  131. // vector relative to its position (copied into `dirn')
  132. TSXAPIFN void tsxAViewGetDirection( CtsxVector3f* dirn );
  133.  
  134. // Get the Bank angle
  135. TSXAPIFN float tsxAViewGetBankAngle();
  136.  
  137. // Get the Zoom
  138. TSXAPIFN float tsxAViewGetZoom();
  139.  
  140. // Use this function to change the position and direction of the active
  141. // view's "eye".  A NULL value for `pEyePosn' or `pLookAt' indicates no
  142. // change in that parameter.
  143. TSXAPIFN void tsxAViewSetView(
  144.     CtsxVector3f* pEyePosn, //New position of eye, in world coordinates
  145.     CtsxVector3f* pLookAt,  //New point at which eye should point, in world coord
  146.     tsxBOOL bLevelIt        //e_tsxTRUE if eye's horizontal axis should be made
  147.                 // parallel to world X, otherwise current bank angle
  148.                 // with world-X is maintained.
  149.     );
  150.  
  151. // Change the bank angle between the view's horizontal axis and the world X axis.
  152. TSXAPIFN void tsxAViewSetBank( float bankAngle );
  153.  
  154. // Change the active view's zoom (clamped to allowed min/max values).
  155. // Returns: the new zoom value.
  156. TSXAPIFN float tsxAViewSetZoom( float newzoom );
  157.  
  158.  
  159. //------------------------------------------------------------------------------
  160. //    Frame relationships
  161. //------------------------------------------------------------------------------
  162.  
  163. // Matrix for transforming world coordinates to viewport (screen) coordinates.
  164. // Returns: pTxmx.
  165. TSXAPIFN CtsxTxmx3f* tsxAViewGetWorld2VportTxmx( CtsxTxmx3f* pTxmx );
  166.  
  167. // Matrix for transforming world coordinates to view's Eye coordinates.
  168. // Returns: pTxmx.
  169. TSXAPIFN CtsxTxmx3f* tsxAViewGetWorld2EyeTxmx( CtsxTxmx3f* pTxmx );
  170.  
  171. // Matrix for transforming view's Eye coordinates to world coordinates
  172. // (inverse of the World-to-Eye matrix).
  173. // Returns: pTxmx.
  174. TSXAPIFN CtsxTxmx3f* tsxAViewGetEye2WorldTxmx( CtsxTxmx3f* pTxmx );
  175.  
  176. // Computes a ray pointing from the eye's viewpoint through the mouse point.
  177. // The ray is returned in pRayOrigin and pRayDirn, the latter giving the
  178. // direction as a normalized vector pointing from pRayOrigin.
  179. // Any of the output arguments may be NULL, if that value is not desired.
  180. TSXAPIFN void tsxAViewGetMouseRay(
  181.     short mousePtX, //IN: mouse X coordinate (in screen space)
  182.     short mousePtY, //IN: mouse Y coordinate
  183.     CtsxVector3f* pRayOrigin, //OUT: Eye location for active view
  184.     CtsxVector3f* pRayDirn    //OUT: Normalized direction from pRayOrigin
  185.     );
  186.  
  187. // Computes screen cordinates of the point in the active view.
  188. TSXAPIFN void tsxAViewGetScreenPoint(
  189.     CtsxVector3f* pWorldPt, //IN: World coordinates
  190.     short* pScreenPtX, //OUT: screen X coordinate (in pixels)
  191.     short* pScreenPtY //OUT: screen Y coordinate
  192.     );
  193.  
  194.  
  195. //------------------------------------------------------------------------------
  196. //    Picking
  197. //------------------------------------------------------------------------------
  198.  
  199. // Pick the Root object in scene containing the object under the mouse.
  200. // A Root object has the scene as its parent.
  201. // Returns: e_tsxTRUE on successful pick.
  202. TSXAPIFN tsxBOOL tsxAViewPickRoot(
  203.     short x, //Screen coordinates of mouse
  204.     short y,
  205.     tsxSOBJ** ppSobj //OUT: Ptr to root object containing picked object.
  206.     );
  207.  
  208. // Picking nearest one of MNode's vertices under the mouse, if any.
  209. // If pMNode is 0 (null) then all objects in scene are tested.
  210. // Returns: e_tsxTRUE on successful pick.
  211. TSXAPIFN tsxBOOL tsxAViewPickVertex(
  212.     tsxMNODE* pMNode,     //Must be a Group or Polyhedron. 0 = all objs in scene.
  213.     short x,        //Screen coordinates of mouse
  214.     short y,
  215.     tsxPOLYHEDRON** ppPolyh, //OUT: Polyhderon whose vertex picked
  216.     int* pVxIndex         //OUT: Index of picked vertex in pPolyh
  217.     );
  218.  
  219. // Picks nearest one of MNode's faces under the mouse, if any.
  220. // If pMNode is 0 (null) then all objects in scene are tested.
  221. // Returns: e_tsxTRUE on successful pick.
  222. TSXAPIFN tsxBOOL tsxAViewPickFace(
  223.     tsxMNODE* pMNode,     //Must be a Group or Polyhedron. 0 = all objs in scene.
  224.     short x,        //Screen coordinates of mouse
  225.     short y,
  226.     tsxPOLYHEDRON** ppPolyh, //OUT: Polyhderon whose face picked
  227.     int* pFxIndex,         //OUT: Index of picked face in pPolyh
  228.     float* pFxDist         //OUT: Distance to picked face
  229.     );
  230.  
  231.  
  232. //------------------------------------------------------------------------------
  233. //    Miscellaneous
  234. //------------------------------------------------------------------------------
  235.  
  236. // Handle to the active view's window
  237. TSXAPIFN HWND tsxAViewGetHwnd();
  238.  
  239.  
  240. //******************************************************************************
  241. #endif // TSXAVIEW_H
  242.